Forward Wrapper API:

Description: Use this API to do multiple tasks in one go, namely creating a quick order, requesting its shipment, and finally generating the label and the manifest for the same order.

This API integrates several other APIs to perform all these tasks together.

Tasks:

Create order
Create shipment
Run serviceability
Check courier rule / priority
Assign AWB
Generate pickup manifest
Generate label PDF
Generate invoice PDF
Generate manifest PDF

Basic Information

NAME	DETAILS
Usage:	Mandatory
URL:	`https://api.rapidshyp.com/rapidshyp/apis/v1/wrapper`
Request Type:	POST
Scheme:	HTTPS
Header (content-type):	`application/json`
Header (rapidshyp-token):	API-Key

Curl

curl --location 'https://api.rapidshyp.com/rapidshyp/apis/v1/wrapper' \
--header 'rapidshyp-token: \
--header 'Content-Type: application/json' \
--data-raw '{
    "orderId": "1111111111",
    "orderDate": "2023-06-30",
    "pickupAddressName": "Home",
    "pickupLocation": {
        "contactName": "abcd",
        "pickupName": "New Seller 1100ordrr01",
        "pickupEmail": "abc@gmail.com",
        "pickupPhone": "9999999999",
        "pickupAddress1": "New Delhi Seller",
        "pickupAddress2": "New Delhi 2 Seller",
        "pinCode": "110001"
    },
    "storeName": "DEFAULT",
    "billingIsShipping": true,
    "shippingAddress": {
        "firstName": "abcd",
        "lastName": "EXT",
        "addressLine1": "Delhi",
        "addressLine2": "New Delhi",
        "pinCode": "110001",
        "email": "abc@gmail.com",
        "phone": "9999999999"
    },
    "billingAddress": {
        "firstName": "Jane",
        "lastName": "Doe",
        "addressLine1": "456 Elm St",
        "addressLine2": "Apt 101",
        "pinCode": "110001",
        "email": "jane.doe@example.com",
        "phone": "9999999999"
    },
    "orderItems": [
        {
            "itemName": "Product 1",
            "sku": "SKU123",
            "description": "Description of product 1",
            "units": 5,
            "unitPrice": 10.0,
            "tax": 0.0,
            "hsn": "HSN123",
            "productLength": 10.0,
            "productBreadth": 5.0,
            "productHeight": 2.0,
            "productWeight": 0.5,
            "brand": "Brand A",
            "imageURL": "https://abcd.jpeg",
            "isFragile": false,
            "isPersonalisable": false
        },
        {
            "itemName": "Product 2",
            "sku": "SKU456",
            "description": "Description of product 2",
            "units": 2,
            "unitPrice": 20.0,
            "tax": 0.0,
            "hsn": "HSN456",
            "productLength": 15.0,
            "productBreadth": 7.0,
            "productHeight": 3.0,
            "productWeight": 0.8,
            "brand": "Brand B",
            "imageURL": "https://abcd.jpeg",
            "isFragile": true,
            "isPersonalisable": true
        }
    ],
    "paymentMethod": "COD",
    "shippingCharges": 100.0,
    "giftWrapCharges": 0.0,
    "transactionCharges": 0.0,
    "totalDiscount": 0.0,
    "totalOrderValue": 500.0,  
    "codCharges": 0.0,
    "prepaidAmount": 0.0,
    "packageDetails": {
        "packageLength": 20.0,
        "packageBreadth": 10.0,
        "packageHeight": 5.0,
        "packageWeight": 2000.0
    }
}'

Note: Either pass unit price or total order value field both cannot be passed in the request body

Request Parameters	Requirement	Remark	Validation
`{`
orderId	Mandatory	Seller order ID on channel/store/website	Minimum 1 character
orderDate	Mandatory	Order created date on channel/store/website	Format: `YYYY-MM-DD`
pickupAddressName	Conditionally-Mandatory	Pickup name created on Rapidshyp platform	API user can either pass pickup name or create pickup. If both details are shared, system will create order on the provided pickup name and will not create a new pickup location.
pickupLocation	Conditionally-Mandatory	Create pickup location on order creation itself
`{`
contactName	Mandatory	Location contact POC name	Minimum 1 character
pickupName	Mandatory	Name of the warehouse/store	Pickup address name must be between 3 and 75 characters long
pickupEmail	Mandatory	Location contact POC email
pickupPhone	Mandatory	Location contact POC phone number	Phone number must start from 6, 7, 8, or 9
pickupAddress1	Mandatory	Warehouse/store address line 1	Pickup address line 1 must be between 3 and 100 characters long
pickupAddress2	Non-Mandatory	Warehouse/store address line 2	If entered, pickup address line 2 must be between 3 and 100 characters long
pinCode	Mandatory	Location Pincode	Must be 6-digit pincode
`},`
storeName	Mandatory	Store name created on Rapidshyp	If you have one custom channel, pass `"DEFAULT"`
billingIsShipping	Mandatory	Pass true if both shipping and billing are same. In case false, billing address cannot be empty.
shippingAddress	Mandatory	Shipping address details
`{`
firstName	Mandatory	Customer first name	The combined length of first and last name in the shipping address must be between 3 and 75 characters.
lastName	Non-Mandatory	Customer last name
addressLine1	Mandatory	Shipping address line 1	Must be between 3 and 100 characters long
addressLine2	Non-Mandatory	Customer Address line 2	If entered, Shipping address line 2 must be between 3 and 100 characters long.
pinCode	Mandatory	Customer address pincode	Must be 6 digit valid pincode
email	Non-Mandatory	Customer email
phone	Mandatory	Customer phone number	Phone number must start from 6,7,8,9
`},`
billingAddress	Conditionally-Mandatory	Only pass incase billingIsShipping: false
`{`
firstName	Mandatory	Billing customer first name	The combined length of the first and last name in the shipping address must be between 3 and 75 characters.
lastName	Non-Mandatory	Billing customer last name
addressLine1	Mandatory	Billing customer Address line 1	Billing address line 1 must be between 3 and 100 characters long
addressLine2	Non-Mandatory	Billing customer Address line 2	If entered, Billing address line 2 must be between 3 and 100 characters long
pinCode	Mandatory	Billing customer Address Pincode	Must be 6 digit valid pincode
email	Mandatory	Billing customer email
phone	Mandatory	Billing customer phone number	Phone number must start from 6,7,8,9
`},`
orderItems	Mandatory	Item level details
`{`
itemName	Mandatory	Item Name	Order line item name must be between 3 and 200 characters long
sku	Non-Mandatory	Item SKU Id	Order line item sku must be between 3 and 200 characters long
description	Non-Mandatory	Description of product	Minimum 1 character
units	Mandatory	Quantity of items	Item quantity must be greater than 0 in items
unitPrice (Either this or total unit value)	Conditionally-Mandatory	Unit price of SKU inclusive of Taxes	Item unit price must be greater than 0 in items. Note: Either pass unit price or total order value field, both cannot be passed in the request body.
tax	Mandatory	Tax	Pass 0 incase of zero tax item
hsn	Non-Mandatory	HSN code
productLength	Non-Mandatory	Product dimension length	In cm
productBreadth	Non-Mandatory	Product dimension breadth	In cm
productHeight	Non-Mandatory	Product dimension height	In cm
productWeight	Non-Mandatory	Product dimension weight	In gm
brand	Non-Mandatory	Brand of product
imageURL	Non-Mandatory	Image URL
isFragile	Non-Mandatory	If fragile item, pass true
isPersonalisable	Non-Mandatory	If personalisable, pass true
`},`
`],`
paymentMethod	Mandatory	Payment mode of order	Payment mode — please choose from `[COD, PREPAID]`
shippingCharges	Non-Mandatory	Shipping charges
giftWrapCharges	Non-Mandatory	Gift wrap charges
transactionCharges	Non-Mandatory	Transaction charges
totalDiscount	Non-Mandatory	Total discount
totalOrderValue	Conditionally-Mandatory	Total order value	Note: either pass unit price or total order value field — both cannot be passed in the request body.
codCharges	Non-Mandatory	COD charges
prepaidAmount	Non-Mandatory	Prepaid amount	Pass partially paid amount in case of partial paid order. System then calculates collectible amount. Prepaid amount is only applicable on COD payment mode.
packageDetails	Mandatory	Prepaid amount
`{`
packageLength	Mandatory	packageLength	In cm
packageBreadth	Mandatory	packageBreadth	In cm
packageHeight	Mandatory	packageHeight	In cm
packageWeight	Mandatory	packageWeight	In gm
`}`
`}`

Response:

JSON



{
    "status": "SUCCESS",
    "remarks": "",
    "orderId": "1111111111",
    "orderCreated": true,
    "shipment": [
        {
            "shipmentId": "1111111111",
            "awbGenerated": true,
            "labelGenerated": true,
            "pickupScheduled": true,
            "awb": "1111111111111",
            "courierCode": "Ecom Express Surface",
            "courierName": "Ecom Express Surface",
            "parentCourierName": "Ecom Express",
            "appliedWeight": 63.0,
            "labelURL": "https://rapidshyp_labels/Label_10Jul24.pdf",
            "manifestURL": "https://rapidshyp-public.s3.ap-south-1.amazonawsanifest_52.pdf",
            "routingCode": "NOI",
            "rtoRoutingCode": "NOI",
            "pickupName": "Home",
            "paymentMethod": "COD",
            "shippingCharges": 100.0,
            "giftWrapCharges": 0.0,
            "transactionCharges": 0.0,
            "totalDiscount": 0.0,
            "totalOrderValue": 150.0,
            "prepaidAmount": 0.0,
            "collectableAmount": 150.0,
            "shipmentLines": [
                {
                    "name": "Pwerew",
                    "sku": "Sqwer",
                    "units": 1,
                    "sellingPrice": 10.0
                },
                {
                    "name": "Product 2",
                    "sku": "Product 2",
                    "units": 2,
                    "sellingPrice": 40.0
                }
            ]
        }
    ]
}

Basic Information

Curl​

Note: Either pass unit price or total order value field both cannot be passed in the request body​

Response:​

Curl

Note: Either pass unit price or total order value field both cannot be passed in the request body

Response: